home *** CD-ROM | disk | FTP | other *** search
/ Atari Forever 4 / Atari Forever 4.zip / Atari Forever 4.iso / SERIE_AI / AI_074 / MENUINFO / ENGLISH / MENUINFO.ASC < prev    next >
Text File  |  1998-03-14  |  16KB  |  675 lines
  1.                          The documentation of
  2.  
  3.                                MenuInfo
  4.  
  5.                              Version 2.49
  6.                               1996/02/16
  7.  
  8.                                   by
  9.  
  10.                             Dirk Hagedorn
  11.                            In der Esmecke 9
  12.                            D-59846 Sundern
  13.  
  14.                        dh@mk2.maus.sauerland.de
  15.  
  16.  
  17.  
  18. Contents
  19. ========
  20.  
  21.  1 Introduction
  22.  
  23.  2 Configuration
  24.    2.1 Refresh
  25.    2.2 Redraw
  26.    2.3 Offset
  27.    2.4 Small font
  28.    2.5 Use window
  29.    2.6 CapsLock-LED
  30.    2.7 OFLS-LED
  31.    2.8 Top windows
  32.    2.9 Screensaver
  33.    2.10 Alarm
  34.    2.11 VSCR-support
  35.  
  36.  3 Clicks onto the LEDs
  37.    3.1 Hint for users of TakeOff
  38.  
  39.  4 Placeholders
  40.  
  41.  5 ASCII-table
  42.  
  43.  6 Systemrequirements
  44.  
  45. Appendix
  46. ========
  47.  
  48.  A Legal information
  49.    A.1 Copyright
  50.    A.2 Fairware
  51.    A.3 Disclaimer
  52.  
  53.  B Future
  54.  
  55.  C The current version
  56.  
  57.  D Thanks
  58.  
  59.  E History
  60.    E.1 Version 2.49
  61.    E.2 Version 2.42
  62.    E.3 Version 2.41
  63.    E.4 Version 2.40
  64.  
  65.  
  66.  
  67.                               Chapter 1 
  68.  
  69.                              Introduction
  70.  
  71. First of all: please excuse my bad english! I did my very best. ;-)
  72.  
  73. MenuInfo is a small utility to show userdefined information in the
  74. unused upper right corner of the screen.
  75.  
  76. MenuInfo offers the following features:
  77.  
  78.    ∙ it runs in application- and accessory mode
  79.  
  80.    ∙ output via AES-objects, so there will be no problems using diffe-
  81.      rent systemfonts
  82.  
  83.    ∙ XSSI-support, so MenuInfo doesn't outputs anything while a
  84.      screensaver is active (e.g. Before Dawn)
  85.  
  86.    ∙ VSCR-support
  87.  
  88.    ∙ VA_START-support
  89.  
  90.    ∙ MenuInfo supports Ralf Zimmermann's DCF77 driver
  91.  
  92.    ∙ ST-Guide-support
  93.  
  94.    ∙ an X-Windows-like autotopper for windows
  95.  
  96.    ∙ a little screensaver
  97.  
  98.    ∙ optional output of information in a window
  99.  
  100.    ∙ MenuInfo's information might be copied to the clipboard
  101.  
  102.    ∙ MenuInfo shows the status of CapsLock and OFSL using small LEDs
  103.  
  104.    ∙ online-configuration
  105.  
  106.    ∙ saveable and loadable configuration
  107.  
  108.    ∙ MenuInfo uses only about 50,000 bytes
  109.  
  110.  
  111.  
  112.                               Chapter 2 
  113.  
  114.                             Configuration
  115.  
  116. After clicking the left mousebutton while pointing onto the LEDs and
  117. pressing no special keys (Shift, Control, Alternate) or after selec-
  118. ting MenuInfo's menuentry in the deskmenu a formular will be opened.
  119.  
  120. You can see some editfields and lots of buttons.
  121.  
  122. Enter placeholder-combinations into the editfields. If a button next
  123. to an editfield is selected this information will be displayed. The
  124. other buttons will be discussed later.
  125.  
  126.  
  127. 2.1 Refresh
  128. ===========
  129.  
  130. This value means how long MenuInfo waits until it updates its informa-
  131. tion. Values lower than 50 msec aren't allowed. Values between 200
  132. and 500 msec are fine.
  133.  
  134. The lower this value is the more time is used by MenuInfo!
  135.  
  136.  
  137. 2.2 Redraw
  138. ==========
  139.  
  140. This value means after how much periods of refreshing the information
  141. MenuInfo should redraw them.
  142.  
  143. What sense does it make? If a program has more than one menubar, Menu-
  144. Info's information will be overwritten if these menubars change. But
  145. MenuInfo has no possibility to notice that and if then the informa-
  146. tion wouldn't change you wouldn't see the information anymore.
  147.  
  148. The lower this value is the more time is used by MenuInfo!
  149.  
  150.  
  151. 2.3 Offset
  152. ==========
  153.  
  154. This value means the number of chars that the information will be
  155. shifted to the left. So you will be able to use MenuInfo together
  156. with some other tools like ShowTime, LED-Panel... which are also
  157. using the upper right corner.
  158.  
  159.  
  160. 2.4 Small font
  161. ==============
  162.  
  163. Just select it and watch the difference...
  164.  
  165.  
  166. 2.5 Use window
  167. ==============
  168.  
  169. If this button is selected MenuInfo displays the information in a
  170. small window.
  171.  
  172. "Redraw", "Offset", "VSCR-support" and "Small font" have no meaning
  173. for this window.
  174.  
  175. When MenuInfo receives a AC_CLOSE-message or you close the window
  176. MenuInfo will display the information in the upper right corner
  177. again.
  178.  
  179.  
  180. 2.6 CapsLock-LED
  181. ================
  182.  
  183. If this button is selected MenuInfo displays a small LED in the upper
  184. left corner of the screen. If this LED is green, CapsLock is active.
  185. Otherwise it is inactive.
  186.  
  187.  
  188. 2.7 OFLS-LED
  189. ============
  190.  
  191. If this button is selected MenuInfo displays a small LED in the upper
  192. left corner of the screen. If this LED is red, you have opened files
  193. on your (hard)disc.
  194.  
  195. To use the OFLS-LED you have to install the freeware-program
  196. CHK_OFLS.PRG from the Kobold-distribution.
  197.  
  198.  
  199. 2.8 Top windows
  200. ===============
  201.  
  202. If this button is selected, MenuInfo tops the window under the mouse-
  203. arrow automatically, but only if...
  204.  
  205.    ∙ the mousearrow is inside the workingarea of a window
  206.  
  207.    ∙ the mousearrow has the same position for 50 msec
  208.  
  209.    ∙ no special key (Shift, Control, Alternate) is pressed
  210.  
  211.    ∙ the current window won't be complety hidden by the new window
  212.  
  213.  
  214. 2.9 Screensaver
  215. ===============
  216.  
  217. If this button is selected MenuInfo's screensaver is active. It's not
  218. really a screensaver that checks the keyboard or the serial inter-
  219. face(s). If you are looking for something like that, just buy Before
  220. Dawn, Twilight or something else.
  221.  
  222. No, you have to tell MenuInfo that it should save the screen. This is
  223. done by moving the mousearrow into the lower right corner of the
  224. screen.
  225.  
  226. Furthermore you can enter a value that represents the period of time,
  227. after which MenuInfo automatically starts to save the screen if you
  228. don't move the mouse. Entering a "0" means, that MenuInfo should't
  229. start saving the screen automatically. MenuInfo doesn't start saving
  230. the screen if you move the mouse arrow into the lower left corner of
  231. the screen.
  232.  
  233. Then MenuInfo will draw a black screen and will invert the menubar.
  234. MenuInfo will update its information while saving the screen!
  235.  
  236. After moving the mouse MenuInfo redraws the screen via
  237. form_dial(FMD_FINISH,...)).
  238.  
  239.  
  240. 2.10 Alarm
  241. ==========
  242.  
  243. Select the button and enter an alarmtime. When this time arrives Menu-
  244. Info will show you a message inside an alertbox.
  245.  
  246.  
  247. 2.11 VSCR-support
  248. =================
  249.  
  250. If you run a virtual resolution you have to scroll to the upper right
  251. corner to see the information displayed by MenuInfo. But if you se-
  252. lect this button and a menubar is displayed in the current part of
  253. the virtual screen, MenuInfo will also show its infornation in this
  254. upper right corner.
  255.  
  256.  
  257.  
  258.                               Chapter 3 
  259.  
  260.                          Clicks onto the LEDs
  261.  
  262. Click onto the LEDs and press a special key to get the follwing
  263. action:
  264.  
  265.    ∙ left mousebutton
  266.      open the configuration formular
  267.  
  268.    ∙ Alternate + left mousebutton
  269.      redraw the screen
  270.  
  271.    ∙ Shift + left mousebutton
  272.      open the fileselector
  273.  
  274.    ∙ Control + left mousebutton
  275.      copy MenuInfo's information to the clipboard
  276.  
  277.    ∙ Shift + Control + left mousebutton
  278.      send MenuInfo information via appl_tplay()
  279.  
  280.    ∙ right mousebutton
  281.      open the ASCII-table
  282.  
  283.    ∙ Alternate + right mousebutton
  284.      sends the AV_STARTPROG message to the AV_SERVER to start a
  285.      program you have to put on your own into the configuration file.
  286.      Example:
  287.  
  288.      LAUNCH@d:\dh-soft\move_it\move_it.app@@@
  289.  
  290.      First you have to write the word "LAUNCH" followed by an "@".
  291.      Then insert the full path of the program followed by three
  292.      further "@".
  293.  
  294.    ∙ Shift + right mousebutton
  295.      open an extended fontselector (Calvino, FontSel)
  296.  
  297.    ∙ Control + right mousebutton
  298.      quit MenuInfo
  299.  
  300.  
  301. 3.1 Hint for users of TakeOff
  302. =============================
  303.  
  304. MenuInfo places its LEDs in the upper left corner that is usually
  305. used by TakeOff. So you have simply no chance to open the popup of
  306. TakeOff here. But TakeOff offers a second chance to open its popup:
  307. just click into the upper right corner!
  308.  
  309.  
  310.  
  311.                               Chapter 4 
  312.  
  313.                              Placeholders
  314.  
  315. Use these placeholders inside the editfields of the configuration
  316. formular:
  317.  
  318. Some hints:
  319.  
  320.    ∙ italic ones aren't implemented yet
  321.  
  322.    ∙ absolute processes:
  323.      number of all running processes
  324.  
  325.    ∙ relative processes:
  326.      the difference between the number of processes that are nopw
  327.      running and the number of processes that where already running
  328.      when MenuInfo startet
  329.  
  330.  %a:   short weekday (Mon, Tue, ...)
  331.  
  332.  %A:   long weekday (Monday, Tuesday, ...)
  333.  
  334.  %b:   short month (Jan, Feb, ...)
  335.  
  336.  %B:   long month (January, February ...)
  337.  
  338.  %c:   date and time (17.08.1995 11:40:30)
  339.  
  340.  %d:   day of month (1-31)
  341.  
  342.  %D:   day of month (01-31)
  343.  
  344.  %f:   short fuzzy-time (10 past 12)
  345.  
  346.  %F:   long fuzzy-time (ten past twelve)
  347.  
  348.  %H:   hour (00-23)
  349.  
  350.  %I:   hour (00-12)
  351.  
  352.  %j:   day of year (1-366)
  353.  
  354.  %l:   the LF-char (a bell in the systemfont)
  355.  
  356.  %L:   the alarmtime
  357.  
  358.  %m:   month (01-12)
  359.  
  360.  %M:   minute (00-59)
  361.  
  362.  %o:   month (1-12)
  363.  
  364.  %p:   AM/PM
  365.  
  366.  %r:   time as %I:%M:%S %p (11:42:54 AM)
  367.  
  368.  %R:   time %I:%M (11:43)
  369.  
  370.  %S:   second (00-59)
  371.  
  372.  %t:   the TAB-char (a small clock in the systemfont)
  373.  
  374.  %T:   time as %H:%M:%S (11:44:10)
  375.  
  376.  %U:   time as %H:%M (11:44)
  377.  
  378.  %w:   weekday (0-6)
  379.  
  380.  %W:   /week of year (0-52)/
  381.  
  382.  %x:   local date (17.08.95)
  383.  
  384.  %X:   local time (11:44:56)
  385.  
  386.  %y:   short year (0-99)
  387.  
  388.  %Y:   long year (1995)
  389.  
  390.  %%:   the %-char
  391.  
  392.  $c:   coordinates of the complete window under the mousearrow
  393.  
  394.  $C:   coordinates of the complete top window
  395.  
  396.  $h:   handle of the window under the mousearrow
  397.  
  398.  $H:   handle of the top window
  399.  
  400.  $l:   /CPU-load/
  401.  
  402.  $m:   coordinates des mousearrows
  403.  
  404.  $o:   number of opened files
  405.  
  406.  $n:   owner of the window under the mousearrow
  407.  
  408.  $N:   owner of the top window
  409.  
  410.  $r:   sum of the biggest memoryblocks (bytes)
  411.  
  412.  $R:   sum of the biggest memoryblocks (KB)
  413.  
  414.  $s:   biggest memoryblock of ST-RAM (bytes)
  415.  
  416.  $S:   biggest memoryblock of ST-RAM (KB)
  417.  
  418.  $t:   biggest memoryblock of TT-RAM (bytes)
  419.  
  420.  $T:   biggest memoryblock of TT-RAM (KB)
  421.  
  422.  $w:   coordinates of working-area of the window under the mousearrow
  423.  
  424.  $W:   coordinates of working-area of the top window
  425.  
  426.  $D:   statuts of DCF77
  427.  
  428.  $P:   used port of DCF77
  429.  
  430.  $Z:   timezone of DCF77
  431.  
  432.  $7:   error number of DCF77
  433.  
  434.  $$:   the $-char
  435.  
  436.  &a:   AES-Version (3.99)
  437.  
  438.  &c:   /number of free cookies/
  439.  
  440.  &C:   cookie-jar-size
  441.  
  442.  &d:   TOS-version (2.00)
  443.  
  444.  &D:   TOS-date (10.08.1993)
  445.  
  446.  &g:   GEMDOS-version (0.19)
  447.  
  448.  &k:   scancode of the latest pressed key (0x6200)
  449.  
  450.  &m:   Mag!X-version (2.00)
  451.  
  452.  &M:   Mag!X-date (26.08.1993)
  453.  
  454.  &n:   NVDI-version (3.01)
  455.  
  456.  &N:   NVDI-datum (25.11.1994)
  457.  
  458.  &o:   CHK_OFLS-version (1.03)
  459.  
  460.  &w:   /WINX-version/
  461.  
  462.  &&:   the &-char
  463.  
  464.  #a:   absolute applications
  465.  
  466.  #A:   relative applications
  467.  
  468.  #c:   absolute accessories
  469.  
  470.  #C:   relative accessories
  471.  
  472.  #p:   absolute processes
  473.  
  474.  #P:   relative processes
  475.  
  476.  #y:   absolute system-processes
  477.  
  478.  #Y:   relative system-Processes
  479.  
  480.  ##:   the #-char
  481.  
  482.  
  483.  
  484.                               Chapter 5 
  485.  
  486.                              ASCII-table
  487.  
  488. Click with the right mousebutton onto the LEDs without pressing a
  489. special key to get the ASCII-table.
  490.  
  491. After clicking a char this char will be send to the active applica-
  492. tion via appl_tplay().
  493.  
  494.  
  495.  
  496.                               Chapter 6 
  497.  
  498.                           Systemrequirements
  499.  
  500. MenuInfo is a GEM-application and should run with every hardware- or
  501. software-configuration.
  502.  
  503. *But:*
  504.  
  505.    ∙ MultiTOS kills MenuInfo when using memory protection. I really
  506.      don't know why. :-(
  507.  
  508.    ∙ To see the configuration-formular you have to run a resolution
  509.      with 640 pixels or more.
  510.  
  511.  
  512.  
  513.  
  514.                              Appendix A 
  515.  
  516.                           Legal information
  517.  
  518.  
  519. A.1 Copyright
  520. =============
  521.  
  522. MenuInfo and its documentation are copyrighted by Dirk Hagedorn
  523. Software, Germany.
  524.  
  525. MenuInfo may be given to third persons in a noncommercially way if
  526. all of the following requirements are met:
  527.  
  528.    ∙ The program has to be copied with all and unchanged files.
  529.  
  530.    ∙ It's not allowed to add files (espacially advertisement for a
  531.      BBS or a PD series). Furthermore it's not allowed to rename the
  532.      archive.
  533.  
  534.    ∙ You have to copy MenuInfo free of charge! The upload to a BBS is
  535.      only allowed if its run in a noncommercially way.
  536.  
  537.  
  538. A.2 Fairware
  539. ============
  540.  
  541. MenuInfo ist Fairware!
  542.  
  543. If you like MenuInfo and often use, please send me an email, a post-
  544. card from your hometown or a small amount of money.
  545.  
  546. My address:
  547.  
  548.     Dirk Hagedorn
  549.     In der Esmecke 9
  550.     59846 Sundern
  551.     Germany
  552.  
  553.  
  554. A.3 Disclaimer
  555. ==============
  556.  
  557. MenuInfo has been test on my computer and it works fine. A lot of
  558. other users are using MenuInfo without any problems. But:
  559.  
  560.     Use MenuInfo on your own risk!
  561.  
  562.  
  563.  
  564.                              Appendix B 
  565.  
  566.                                 Future
  567.  
  568. MenuInfo will be updated to my own requirements. If I get some reso-
  569. nance I'll publish further versions. If I don't hear anything of
  570. anybody I will not publish further version. Why should I if I must
  571. think that nobody uses MenuInfo?
  572.  
  573.  
  574.  
  575.                              Appendix C 
  576.  
  577.                          The current version
  578.  
  579. The current version of MenuInfo is always available in the "Öffentli-
  580. cher Programmteil" of the Maus MK2 (+49 2371 944925).
  581.  
  582. A few days or weeks later the current version is available via FTP
  583. (members.aol.com/DirkHage/atari/). You can find a link to the current
  584. version on my World Wide Web site. Just take a look at:
  585.  
  586.     http://members.aol.com/DirkHage/www/eng/menuinfo.htm
  587.  
  588. The archiv is named always "MINF???.LZH", "???" is replaced by the
  589. number of version.
  590.  
  591.  
  592.  
  593.                              Appendix D 
  594.  
  595.                                 Thanks
  596.  
  597. Many thanks to ...
  598.  
  599.  Dirk Haun       for his wind_get-routine
  600.  
  601.  Uwe Heidemann   for testing the DCF77 support.
  602.  
  603.  Thomas Binder   for his hints according to the topping of windows
  604.                  under SingleTOS
  605.  
  606. A special thank to the following persons who where so kind to send me
  607. some money for MenuInfo: Sven Grull, Carsten Friehe, Ulli Hahndorf,
  608. Michael Harwerth, Dieter Intas, Michael Kehr, Dirk Kohle, Dirk
  609. Paulsberg, Wolfgang Simon, Oliver Stenzel, Thomas Ungricht, Lothar
  610. Wagner, Michael Wurm and to those who I've forgotten to place in this
  611. list.
  612.  
  613.  
  614.  
  615.                              Appendix E 
  616.  
  617.                                History
  618.  
  619.  
  620. E.1 Version 2.49
  621. ================
  622.  
  623.  New: MenuInfo supports now Ralf Zimmermann's DCF77 driver. Use the
  624.       placeholders $D, $P, $Z or $7.
  625.  
  626.  New: Alternate & right mousebutton starts a program via
  627.       AV_STARTPROG.
  628.  
  629.  New: You can now use 7 different setups.
  630.  
  631.  New: To switch over to another setup just place the mouse arrow onto
  632.       the LEDs and press the number of a setup.
  633.  
  634.  
  635. E.2 Version 2.42
  636. ================
  637.  
  638.  New:     MenuInfo doesn't start the screensaver if you move the
  639.           mouse arrow into the lower left corner of the screen.
  640.  
  641.  
  642. E.3 Version 2.41
  643. ================
  644.  
  645.  Changed: Small change in the routine that calls the xFSL.
  646.  
  647.  
  648. E.4 Version 2.40
  649. ================
  650.  
  651. First English version!
  652.  
  653.  
  654.  
  655.                       This text was generated by
  656.                                    
  657.                                  UDO
  658.                                    
  659.                               Release 5
  660.                            (Atari version)
  661.                                    
  662.                      Copyright (c) 1995, 1996 by
  663.                         Dirk Hagedorn Software
  664.                            In der Esmecke 9
  665.                             59846 Sundern
  666.                                Germany
  667.                   Internet: dh@mk2.maus.sauerland.de
  668.                                    
  669.                                    
  670.         UDO is a program that converts files that are written
  671.          in the UDO-Syntax into ASCII, ST-Guide, LaTeX, Rich
  672.        Text Format, Pure C Help, Manualpage, HTML and WinHelp.
  673.  
  674.  
  675.